home *** CD-ROM | disk | FTP | other *** search
/ SGI Varsity Update 1998 August / SGI Varsity Update 1998 August.iso / dist / insight.idb / usr / relnotes / insight / ch5.z / ch5
Text File  |  1998-07-29  |  17KB  |  331 lines
  1.  
  2.  
  3.  
  4.                                   - 1 -
  5.  
  6.  
  7.  
  8.        5.  _K_n_o_w_n__P_r_o_b_l_e_m_s__a_n_d__W_o_r_k_a_r_o_u_n_d_s
  9.  
  10.        This chapter describes the known problems with the current
  11.        release of the IRIS InSight products and how to work around
  12.        them.
  13.  
  14.        5.1  _I_R_I_S__I_n_S_i_g_h_t__L_i_b_r_a_r_y
  15.  
  16.        Some glossary terms (underlined terms in the content) might
  17.        be missing from the Glossary.  When you click on such a
  18.        term, the viewer may beep, indicating a warning that the
  19.        term was not found.
  20.  
  21.        5.2  _I_R_I_S__I_n_S_i_g_h_t__V_i_e_w_e_r
  22.  
  23.           +o Proximity searching does not function in Japanese books
  24.             since the current proximity algorithm is based on space
  25.             delimited words and Japanese words may not be space
  26.             delimited.
  27.  
  28.           +o In boolean searches using two or more words, only the
  29.             first word will be highlighted in the text.
  30.  
  31.           +o Expanding a search using wildcards may highlight
  32.             improper characters in the text.
  33.  
  34.           +o Back of the book indexes are not supported for Japanese
  35.             books.  The item still exists on the menu but will be
  36.             greyed out.
  37.  
  38.           +o After installing a new version of the viewer, you
  39.             should remove any local defaults that may have been
  40.             left around by previous versions. In particular, this
  41.             should be done when going from IRIS InSight version 1.0
  42.             to an upgraded version.  To do this, give this command
  43.             before executing IRIS InSight for the first time after
  44.             an installation:
  45.  
  46.             %%%% rrrrmmmm ~~~~////....iiiinnnnssssiiiigggghhhhttttrrrrcccc
  47.  
  48.           +o Scrolling in the viewer may seem ``jumpy'' due to the
  49.             rendering of images inline.  A workaround is to use the
  50.             line up and line down buttons in the scroll bar, or the
  51.             <Page Up> and <Page Down> buttons on the keyboard.
  52.             Another alternative is to use the ``Settings...''
  53.             option from the Options menu and click on
  54.             ``Figures/Media In-line?'' to not include figures
  55.             inline.
  56.  
  57.           +o If the IRIS InSight viewer is running and a new book or
  58.             set of books are installed, IRIS InSight will not
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.                                   - 2 -
  71.  
  72.  
  73.  
  74.             immediately ``see'' and utilize the new content. In
  75.             order for IRIS InSight to view the newly-installed
  76.             book(s), close and restart the IRIS InSight
  77.             application.
  78.  
  79.           +o Occasionally, the book viewer window might be narrower
  80.             than required to display the full width of a table.  A
  81.             warning message:
  82.  
  83.             YYYYoooouuuurrrr wwwwiiiinnnnddddoooowwww iiiissss ttttoooooooo nnnnaaaarrrrrrrroooowwww ffffoooorrrr tttthhhhiiiissss ttttaaaabbbblllleeee....
  84.             PPPPlllleeeeaaaasssseeee rrrreeeessssiiiizzzzeeee tttthhhheeee wwwwiiiiddddtttthhhh ooooffff tttthhhheeee vvvviiiieeeewwwwiiiinnnngggg aaaarrrreeeeaaaa....
  85.  
  86.             might be generated to the window.  This is not harmful;
  87.             simply widen the window to view the entire table.
  88.  
  89.           +o On systems with few bitplanes, the colors might flash
  90.             due to the limited colormap.
  91.  
  92.           +o Make sure that when printing you select one or more
  93.             entries in the Print Window Table-of-Contents area.
  94.  
  95.           +o Printing portions of a book (or a whole book) with
  96.             graphics included can often take a substantial period
  97.             of time. You may wish to consider printing without
  98.             including graphics. From the Print Window, click on
  99.             ``Print Graphics?'' to not include graphics in the
  100.             printed output.
  101.  
  102.           +o For Systems Administrators, it should be noted that the
  103.             directory /_v_a_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_e_b_t_p_u_b is installed as an
  104.             ``open'' directory, with the permissions being set to
  105.             755. This area is used to store an Insight user's
  106.             bookmarks. Note that this area can be changed through
  107.             the modification of the PUBLIC_DIR and PRIVATE_DIR
  108.             variables found in the IRIS InSight system
  109.             configuration file,
  110.             /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_s_y_s_t_e_m._i_n_s_i_g_h_t_r_c.
  111.  
  112.           +o The following is a suggestion to speed navigation for
  113.             some users. This is simply done by mapping a couple of
  114.             keystrokes to specific scrolling actions. For example,
  115.             the Return Key is used to move down a line in the
  116.             Insight window, and the Space Bar is used to move down
  117.             a page. To do this, these lines go in your .Xdefault or
  118.             app-defaults file:
  119.  
  120.             _I_n_s_i_g_h_t*_X_m_S_c_r_o_l_l_B_a_r._t_r_a_n_s_l_a_t_i_o_n_s: #_o_v_e_r_r_i_d_e \
  121.                 <_K_e_y>_E_n_t_e_r:_I_n_c_r_e_m_e_n_t_D_o_w_n_O_r_R_i_g_h_t(_0)\n\
  122.                 <_K_e_y>_R_e_t_u_r_n:_I_n_c_r_e_m_e_n_t_D_o_w_n_O_r_R_i_g_h_t(_0)\n\
  123.                 <_K_e_y>_s_p_a_c_e:_P_a_g_e_D_o_w_n_O_r_R_i_g_h_t(_0)\n
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.                                   - 3 -
  137.  
  138.  
  139.  
  140.        5.3  _S_G_I_H_e_l_p__V_i_e_w_e_r
  141.  
  142.           +o If the SGIHelp is not installed on the user's machine
  143.             when a request is made for Help, you will receive the
  144.             following warning message:
  145.  
  146.             SSSSGGGGIIIIHHHHeeeellllpppp sssseeeerrrrvvvveeeerrrr pppprrrrooooggggrrrraaaammmm ((((////uuuussssrrrr////ssssbbbbiiiinnnn////ssssggggiiiihhhheeeellllpppp)))) nnnnooootttt ffffoooouuuunnnndddd....
  147.             PPPPlllleeeeaaaasssseeee iiiinnnnssssttttaaaallllllll iiiinnnnssssiiiigggghhhhtttt....sssswwww....ssssggggiiiihhhheeeellllpppp aaaannnndddd ttttrrrryyyy aaaaggggaaaaiiiinnnn....
  148.  
  149.             Installing the insight.sw.sgihelp subsystem should
  150.             remedy the problem.
  151.  
  152.           +o Occasionally, when a help request is made from an
  153.             application, an informational message may come from the
  154.             SGIHelp process:
  155.  
  156.             SSSSoooorrrrrrrryyyy,,,, iiiinnnnffffoooorrrrmmmmaaaattttiiiioooonnnn oooonnnn tttthhhheeee rrrreeeeqqqquuuueeeesssstttteeeedddd hhhheeeellllpppp ttttooooppppiiiicccc iiiissss nnnnooootttt aaaavvvvaaaaiiiillllaaaabbbblllleeee....
  157.             YYYYoooouuuu nnnneeeeeeeedddd ttttoooo iiiinnnnssssttttaaaallllllll cccceeeerrrrttttaaaaiiiinnnn IIIIRRRRIIIISSSS IIIInnnnSSSSiiiigggghhhhtttt bbbbooooooookkkkssss.... FFFFoooorrrr tttthhhheeee pppprrrroooodddduuuucccctttt yyyyoooouuuu
  158.             aaaarrrreeee rrrreeeeqqqquuuueeeessssttttiiiinnnngggg hhhheeeellllpppp oooonnnn,,,, yyyyoooouuuu nnnneeeeeeeedddd ttttoooo iiiinnnnssssttttaaaallllllll tttthhhheeee bbbbooooooookkkk((((ssss)))) iiiinnnn tttthhhheeeesssseeee
  159.             ssssuuuubbbbssssyyyysssstttteeeemmmm((((ssss)))):::: <<<<<<<<bbbbooooooookkkk____nnnnaaaammmmeeee>>>>>>>> <<<<<<<<bbbbooooooookkkk____ssssuuuubbbbssssyyyysssstttteeeemmmm>>>>>>>>
  160.  
  161.             This message indicates that the Help content for this
  162.             application has not been installed. Refer to the the
  163.             ``Installation Information'' found in this document, or
  164.             refer to the release notes for the application that you
  165.             wish to receive help on, for further information.
  166.  
  167.           +o If the on-line books are being mounted from another
  168.             source, and are not installed locally, the directory
  169.             /usr/share/help should also be mounted (or copied) from
  170.             the same source. This directory contains application
  171.             helpmap files which aid SGIHelp in determining what
  172.             information to display for a given help request.
  173.  
  174.             When mounting IRIS InSight books, be aware that SGIHelp
  175.             looks for books under two specific locations. One is
  176.             the default /usr/share/Insight/library/SGI_bookshelves,
  177.             which should contain the English version of all
  178.             available books. The other is the international setting
  179.             of /usr/share/Insight/library/<locale>_bookshelves,
  180.             where <locale> is the value of the LANG environment
  181.             setting. In the case where LANG is set, SGIHelp will
  182.             look first under the <locale>_bookshelves area, and if
  183.             the requested localized help information is not found,
  184.             it will fall back to the default (SGI_bookshelves) and
  185.             examine the English books.
  186.  
  187.           +o If you are using a mountable file system off the CD-ROM
  188.             to retrieve and view your content (see the IRIS InSight
  189.             Release Notes for information on this), and the SGIHelp
  190.             process has been accessing data from it, you may not be
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.                                   - 4 -
  203.  
  204.  
  205.  
  206.             able to eject the CD-ROM immediately, despite the fact
  207.             that the SGIHelp Viewer is not currently being
  208.             displayed.
  209.  
  210.             This is due to the fact that the SGIHelp process
  211.             remains in the process queue waiting to receive other
  212.             help requests. It will remain around for a default time
  213.             of 10 minutes.
  214.  
  215.             Note that the ``10 minutes'' is a configurable number
  216.             which a user could change in the application defaults
  217.             file, or override in a local Xdefaults file. The
  218.             resource is called ``TimeoutInMin''.
  219.  
  220.             After the designated time has passed, SGIHelp will
  221.             quit, allowing the user to eject the CD-ROM. If you
  222.             wish not to wait, then execute the ``killall'' command
  223.             on sgihelp (if other user's are accessing SGIHelp on
  224.             your system, this command should be executed by a
  225.             privileged user):
  226.  
  227.  
  228.             %%%% ////eeeettttcccc////kkkkiiiillllllllaaaallllllll ssssggggiiiihhhheeeellllpppp
  229.  
  230.             Many applications also use the information found on the
  231.             CD-ROM to automatically configure their ``Help'' menu.
  232.             Because of that, ``Help'' menus for these applications
  233.             can be configured improperly, until content becomes
  234.             available. At that point, the application should be
  235.             stopped and re-invoked to ensure that it reads the
  236.             content properly.
  237.  
  238.             The SGIHelp process itself will tell the user if
  239.             content is unavailable.  Upon receiving a request, it
  240.             will start up (if not already running), and display the
  241.             message:
  242.  
  243.  
  244.             CCCCaaaannnnnnnnooootttt ffffiiiinnnndddd aaaannnnyyyy bbbbooooooookkkkssss ttttoooo rrrreeeeaaaadddd!!!! EEEExxxxiiiittttiiiinnnngggg............
  245.  
  246.             Re-mounting the file system off the CD-ROM and making
  247.             another help request from an application should remedy
  248.             this. The alternative is to install the applicable IRIS
  249.             Insight books on your hard disk.
  250.  
  251.             Refer to the ``Installation Information'' found in this
  252.             document, or to the release notes for the application
  253.             that you wish to receive help on, for further
  254.             information.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.                                   - 5 -
  269.  
  270.  
  271.  
  272.        5.4  _S_G_I_H_e_l_p__D_e_v_e_l_o_p_m_e_n_t__(_s_g_i_h_e_l_p___d_e_v_)
  273.  
  274.           +o In order to avoid a potential problem in accessing the
  275.             first available help card in your help book, you may
  276.             wish to put in a copyright notice as the first card
  277.             when you are authoring your book. That particular card
  278.             does not have to be accessible by the interface; it
  279.             basically acts as a filler to avoid a potential
  280.             problem.
  281.  
  282.             Here is a recommended template for the copyright
  283.             notice, which would appear directly after the <DOCHELP>
  284.             opening tag:
  285.  
  286.  
  287.             <<<<FFFFRRRROOOONNNNTTTTMMMMAAAATTTTTTTTEEEERRRR>>>>
  288.             <<<<CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT>>>>
  289.             CCCCooooppppyyyyrrrriiiigggghhhhtttt 1111999999994444,,,, """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy"""" ---- AAAAllllllll RRRRiiiigggghhhhttttssss RRRReeeesssseeeerrrrvvvveeeedddd
  290.             <<<<////CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT>>>>
  291.  
  292.             <<<<PPPPAAAARRRRAAAAGGGGRRRRAAAAPPPPHHHH>>>>
  293.             TTTThhhhiiiissss ddddooooccccuuuummmmeeeennnntttt ccccoooonnnnttttaaaaiiiinnnnssss pppprrrroooopppprrrriiiieeeettttaaaarrrryyyy aaaannnndddd ccccoooonnnnffffiiiiddddeeeennnnttttiiiiaaaallll iiiinnnnffffoooorrrrmmmmaaaattttiiiioooonnnn ooooffff
  294.             """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy"""".... TTTThhhheeee ccccoooonnnntttteeeennnnttttssss ooooffff tttthhhhiiiissss ddddooooccccuuuummmmeeeennnntttt mmmmaaaayyyy nnnnooootttt bbbbeeee ddddiiiisssscccclllloooosssseeeedddd
  295.             ttttoooo tttthhhhiiiirrrrdddd ppppaaaarrrrttttiiiieeeessss,,,, ccccooooppppiiiieeeedddd,,,, oooorrrr dddduuuupppplllliiiiccccaaaatttteeeedddd iiiinnnn aaaannnnyyyy ffffoooorrrrmmmm,,,, iiiinnnn wwwwhhhhoooolllleeee oooorrrr
  296.             iiiinnnn ppppaaaarrrrtttt,,,, wwwwiiiitttthhhhoooouuuutttt tttthhhheeee pppprrrriiiioooorrrr wwwwrrrriiiitttttttteeeennnn ppppeeeerrrrmmmmiiiissssssssiiiioooonnnn ooooffff """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy""""....
  297.             <<<<////PPPPAAAARRRRAAAAGGGGRRRRAAAAPPPPHHHH>>>>
  298.             <<<<////FFFFRRRROOOONNNNTTTTMMMMAAAATTTTTTTTEEEERRRR>>>>
  299.  
  300.           +o The insight.sw.xhelp_dev subsystem requires dev.sw.make
  301.             and inst_dev.sw.base which are available via the IDO
  302.             product.  These are not specified as pre-req's since
  303.             not all user's will have IDO.  However, they are only
  304.             required for the ``smake'' and ``gendist'' utilities
  305.             for making and building the help images.  Changing the
  306.             reference from ``smake'' to ``make'' in the Makefile's
  307.             should allow user's to build the sample books.
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.